Skip to content

Rearranged documentation into Init, Client, Server, Core and Project. - #153

Open
inanpy wants to merge 4 commits into
mainfrom
docs/145-documentation-structure
Open

inanpy wants to merge 4 commits into
mainfrom
docs/145-documentation-structure

Conversation

@inanpy

@inanpy inanpy commented Nov 19, 2026 •

Copy link
Copy Markdown
Screenshot 2026-11-19 at 21 29 03

The API documentation currently puts client, server, and shared models on one page. This change separates them into Client, Server and Core, with grouped navigation and worked examples.

Updated README, added proper installation, usage examples. We now have test and version badges. Links and image URL are absolute so they work in the PyPI package description. (see #74 )

The install guide now lists Python 3.11 as the minimum version. and shows how to check the installed hip version. After #147 , I also updated the timeout examples to use hip.backends.timeout().

I kept the theme, just modified the fonts, spacing and layout.

The docs build works properly, and local links and anchors work. I also tried the examples in a separate project with hip 0.4 from main.

The HEAD example is kept from the existing docs and depends on #132 .

#108 also updates the Content docs. The additions might have to go to the new Core page.

Referance #145

@inanpy
inanpy requested review from cgl and lovelydinosaur November 19, 2026 21:09

@cgl cgl left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @inanpy for the good work!
Overall it looks good from my side, I left a few comments that needs attention.

@@ -0,0 +1,17 @@
{% set groups = [
('Init', [('README', 'Introduction'), ('INSTALLATION', 'Installation')]),

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🤔 What could be an alternative to Init? It reads a bit different to me.

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What about Getting started ? This would cover the installation and the introduction.

Comment thread docs/README.md Resolved
Comment thread docs/README.md
## Contribution

See [Contributing](CONTRIBUTING.md) to get involved.
See [Contributing](https://www.encode.io/hip/contributing/) to get involved.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

♻️ Maybe keep the links internal?

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I used absolute URLs because this README is also used as the PyPI description where relative links would not point to the documentation.

Comment thread docs/README.md
pip install hip
```

See the [installation guide](https://www.encode.io/hip/installation/) for more options.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

♻️ ♻️ ♻️

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same reason here as above.

@lovelydinosaur

Copy link
Copy Markdown
Member

Woah, this is really neat to see, thank you! 😄

(I'm going to need a little bit of time to take this in properly.)

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants